-
Notifications
You must be signed in to change notification settings - Fork 60
Add documentation for contact field label modifier #395
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 5.x
Are you sure you want to change the base?
Conversation
e628de3 to
2f0251c
Compare
Add documentation for the new < /dev/null | label modifier that displays human-readable labels for select and boolean contact fields instead of stored values. Related to mautic/mautic#12620
2f0251c to
e99ebb7
Compare
RCheesley
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few small tweaks here @kuzmany but more importantly, it needs rebasing to the 7.0 branch please!
| - A country select field storing ``us`` can display ``United States`` | ||
| - A boolean field storing ``1`` can display ``Yes`` | ||
|
|
||
| The modifier also works with company fields: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| The modifier also works with company fields: | |
| The modifier also works with Company fields: |
|
|
||
| This modifier works for both Contact fields and Company fields: | ||
|
|
||
| - ``{contactfield=company_type|label}`` - displays the label of a company select field |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - ``{contactfield=company_type|label}`` - displays the label of a company select field | |
| - ``{contactfield=company_type|label}`` - displays the label of a Company select field |
| This modifier works for both Contact fields and Company fields: | ||
|
|
||
| - ``{contactfield=company_type|label}`` - displays the label of a company select field | ||
| - ``{contactfield=company_active|label}`` - displays the label of a company boolean field |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - ``{contactfield=company_active|label}`` - displays the label of a company boolean field | |
| - ``{contactfield=company_active|label}`` - displays the label of a Company boolean field |
Description
This PR adds documentation for the new
< /dev/null | labelmodifier that allows displaying human-readable labels for select and boolean contact fields instead of their stored values.Changes
/docs/configuration/variables.rstexplaining the label modifier syntax/docs/channels/emails.rstunder Tokens section with examplesExamples documented
{contactfield=select_alias|label}{contactfield=bool_alias|label}{contactfield=company_select_alias|label}{contactfield=company_bool_alias|label}Related PR
Related to mautic/mautic#12620